Creating a new Organization Membership

Request

Applies an organization to a workspace (project) or user.

Bulk Create

This endpoint supports bulk creating up to 100 objects. In the request body, set the top-level key to its plural form and place the objects in an array. Example:

{
  "organization_memberships": [
    {
      "geography_id": 123,
      "department_id": 456,
      "member_id": 111,
      "member_type": "User"
    },
    {
      "geography_id": 123,
      "department_id": 456,
      "member_id": 222,
      "member_type": "User"
    }
  ]
}

This endpoint returns structured Organization Membership objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the organization_memberships top-level JSON key. Please see our Response Format section for more information.

Query

includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

department (Organization) - The department of the associated member.
geography (Organization) - The geography of the associated member.

optional_fieldsArray of strings

Allows you to request one or more optional fields as an array.

Items Enum:"effective_start_date""effective_end_date"

Bodyapplication/jsonrequired

organization_membershipobject

{
  "organization_membership": {
    "geography_id": 0,
    "department_id": 0,
    "member_id": 0,
    "member_type": "string"
  }
}

Responses

Organization Membership has been created.

Bodyapplication/json

countinteger, (int32)

metaobject

resultsArray of objects

organization_membershipsobject

organizationsobject

Response

{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "organization_memberships": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "department_id": "string",
      "effective_end_date": "2019-08-24",
      "effective_start_date": "2019-08-24",
      "geography_id": "string",
      "member_id": "string",
      "member_type": "string",
      "primary": true,
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "department_id": "string",
      "effective_end_date": "2019-08-24",
      "effective_start_date": "2019-08-24",
      "geography_id": "string",
      "member_id": "string",
      "member_type": "string",
      "primary": true,
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "organizations": {
    "property1": {
      "ancestor_ids": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "name": "string",
      "parent_id": "string",
      "type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "ancestor_ids": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "name": "string",
      "parent_id": "string",
      "type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  }
}